Skip to content

[docs] Add troubleshooting section for language support load failures in aspire new#1024

Open
aspire-repo-bot[bot] wants to merge 1 commit into
release/13.4from
docs/surface-integration-assembly-load-failures-17311-20e0a1178a52db6b
Open

[docs] Add troubleshooting section for language support load failures in aspire new#1024
aspire-repo-bot[bot] wants to merge 1 commit into
release/13.4from
docs/surface-integration-assembly-load-failures-17311-20e0a1178a52db6b

Conversation

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#17311

Authored by @IEvangelist.

Targeting release/13.4 based on the source PR milestone 13.4.

Why this PR is needed

microsoft/aspire#17311 hardened the diagnostics for integration-assembly load failures in the aspire new code-generation path. Before this change, when a language support or code generator assembly failed to load its types, users saw only a bare No language support found for: X error with no indication of the root cause.

After the change:

  • Error messages list the available languages when a specific language is not found.
  • When no language support is discovered at all, the error explicitly points users to the apphost-server log for LoaderExceptions warnings and explains the likely binary-mismatch cause.
  • A new Warning-level log entry names the offending assembly and the version mismatch (bundled vs. on-disk) to make self-diagnosis possible.

Documentation changes

Added a Troubleshooting section to src/frontend/src/content/docs/reference/cli/commands/aspire-new.mdx that:

  • Shows the two new error-message shapes users may see.
  • Explains that these errors indicate an integration-assembly version mismatch.
  • Provides resolution steps: aspire cache clear followed by a fresh aspire new run.
  • Directs users to search the log for LoaderExceptions or version mismatch warnings.
  • Includes a tip on using --log-level Debug to capture a detailed log.

Files modified

  • src/frontend/src/content/docs/reference/cli/commands/aspire-new.mdx — added Troubleshooting section (38 lines)

Generated by PR Documentation Check for issue #17311 · ● 58.9M ·

…in aspire new

Documents the improved diagnostics surfaced in microsoft/aspire#17311:
- New error messages that list available languages when a specific language
  is not found
- The binary-mismatch error message and guidance when no language support
  implementations are discovered at all
- Resolution steps (aspire cache clear, checking the log for LoaderExceptions
  and version mismatch warnings)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label May 20, 2026
@aspire-repo-bot aspire-repo-bot Bot requested a review from eerhardt May 20, 2026 18:34
@IEvangelist IEvangelist marked this pull request as ready for review May 21, 2026 18:01
@IEvangelist IEvangelist self-requested a review as a code owner May 21, 2026 18:01
Copilot AI review requested due to automatic review settings May 21, 2026 18:01
@IEvangelist IEvangelist requested a review from mitchdenny as a code owner May 21, 2026 18:01
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a Troubleshooting section to the aspire new CLI command reference to help users diagnose and resolve language support / code generator load failures (typically caused by integration assembly version mismatches), aligning docs with the improved diagnostics in microsoft/aspire#17311.

Changes:

  • Documents the updated “language support not found” error shapes (including the “no implementations discovered” case).
  • Provides resolution steps (aspire cache clear, then re-run aspire new) and guidance to inspect logs for LoaderExceptions / version mismatch warnings.
  • Adds a tip for using --log-level Debug / Trace to capture more detailed logs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +196 to +197
This usually indicates a binary mismatch between the bundled apphost server and the integration assemblies on disk;
check the apphost server log for 'LoaderExceptions' Warnings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant